/*
 * Copyright (c) 2008-2020, Hazelcast, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hazelcast.sql.impl;

import com.hazelcast.sql.SqlResult;
import com.hazelcast.sql.impl.optimizer.SqlPlan;
import com.hazelcast.sql.impl.schema.TableResolver;
import com.hazelcast.sql.impl.schema.map.JetMapMetadataResolver;

import java.util.List;

/**
 * Provides execution support for running SQL statements on Jet. This is
 * the part that's on core code, {@link #sqlBackend()} returns the part
 * that's on the hazelcast-sql module.
 */
public interface JetSqlCoreBackend {

    String SERVICE_NAME = "hz:impl:jetSqlCoreBackend";

    /**
     * Return Jet-specific {@link TableResolver}s.
     */
    List<TableResolver> tableResolvers();

    /**
     * Return {@link JetMapMetadataResolver}.
     */
    JetMapMetadataResolver mapMetadataResolver();

    /**
     * Return Jet-specific {@code com.hazelcast.sql.impl.calcite.SqlBackend}.
     */
    Object sqlBackend();

    /**
     * Execute Jet specific {@link SqlPlan}s.
     */
    SqlResult execute(SqlPlan plan, List<Object> params, long timeout, int pageSize);

    void reset();

    void shutdown(boolean terminate);
}
